Skip to main content

UserInputObject

Members

The Waste of Space equivalent of ROBLOX's InputObject.


KeyCode

Contains a Enum.KeyCode enum that describes what kind of input was used. For types of input like keyboard, this describes what key was pressed. For inputs like the mouse, this provides no additional information. It is of the type Enum.KeyCode.


KeyName

Will be capitalised if Enum.KeyCode.LeftShift or Enum.KeyCode.RightShift was held at the time of the input. It is of the type string.


UserInputState

Describes what the state of input this UserInputObject represents, such as whether the input has began, ended, or been changed somehow. It is of the type Enum.UserInputState.


UserInputType

Describes what kind of input this UserInputObject represents, such as mouse, keyboard, touch or gamepad input. It is of the type Enum.UserInputType.

Luau Type

This is the luau type for UserInputObject. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

export type UserInputObject = {
KeyName: string,
UserInputState: Enum.UserInputState,
UserInputType: Enum.UserInputType,
KeyCode: Enum.KeyCode,
}